Skip to content

Store adapter — DEAR Systems

The adapter object contains properties for connecting to the DEAR Systems API.

Parent object: a store with property "platform" : "dear_systems"

Required properties

The following adapter properties are required for DEAR Systems stores.

account_id

Propertyaccount_id
NameAccount ID
Data typestring
Required?Yes

application_key

Propertyapplication_key
NameApplication Key
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for DEAR Systems stores.

default_box_id

Propertydefault_box_id
NameDefault Box ID
Data typestring

import_status

Propertyimport_status
NameImport Status
DescriptionImport orders with the specified sale status
Data typestring
Accepted values
  • "ORDERED" — for Ordered
  • "PACKED" — for Packed
  • "PICKED" — for Picked
  • "PACKING" — for Packing
  • "PICKING" — for Picking
  • "ORDERING" — for Ordering
  • "BACKORDERED" — for Backordered
  • "INVOICED" — for Invoiced
  • "CREDITED" — for Credited
  • "COMPLETED" — for Completed
Default"ORDERED"

update_on_hand

Propertyupdate_on_hand
NameUpdate On Hand
DescriptionEnable to support Inventory Update
Data typeboolean
Defaultfalse

warehouse_location

Propertywarehouse_location
NameWarehouse Location
DescriptionImport orders only from the specified location
Data typestring

Example

Example: create a new DEAR Systems store
curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your DEAR Systems Store",
  "platform": "dear_systems",
  "adapter": {
    "account_id": "abc123",
    "application_key": "abc123",
    "default_box_id": "abc123",
    "warehouse_location": "abc123",
    "import_status": "BACKORDERED",
    "update_on_hand": false
  }
}
EOF

For details about this request type, see: Create a new store.